<!-- HTML header for doxygen 1.8.18-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Ipopt: Ipopt::ReferencedObject Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  $(document).ready(function() { init_search(); });
/* @license-end */
</script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
  extensions: ["tex2jax.js"],
  jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
<link href="stylesheet.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 40px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Ipopt Documentation
   &#160;<!--span id="projectnumber">3.14.15</span-->
   </div>
  </td>
   <td>        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
          <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
          </span>
        </div>
</td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('classIpopt_1_1ReferencedObject.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classIpopt_1_1ReferencedObject-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">Ipopt::ReferencedObject Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Storing the reference count of all the smart pointers that currently reference it.  
 <a href="classIpopt_1_1ReferencedObject.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="IpReferenced_8hpp_source.html">IpReferenced.hpp</a>&gt;</code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for Ipopt::ReferencedObject:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classIpopt_1_1ReferencedObject__inherit__graph.png" border="0" usemap="#aIpopt_1_1ReferencedObject_inherit__map" alt="Inheritance graph"/></div>
<map name="aIpopt_1_1ReferencedObject_inherit__map" id="aIpopt_1_1ReferencedObject_inherit__map">
<area shape="rect" title="Storing the reference count of all the smart pointers that currently reference it." alt="" coords="5,1175,184,1202"/>
<area shape="rect" href="classIpopt_1_1AlgorithmBuilder.html" title="Builder for creating a complete IpoptAlg object." alt="" coords="261,132,434,160"/>
<area shape="poly" title=" " alt="" coords="93,1159,99,1025,117,815,134,694,158,569,189,443,229,322,253,272,281,226,331,159,336,162,285,229,257,275,234,324,194,445,163,570,140,695,123,816,104,1025,99,1159"/>
<area shape="rect" href="classIpopt_1_1AlgorithmStrategyObject.html" title="This is the base class for all algorithm strategy objects." alt="" coords="257,336,438,380"/>
<area shape="poly" title=" " alt="" coords="94,1159,103,1001,125,771,142,652,165,543,194,453,211,418,230,391,255,372,258,376,234,394,215,420,199,455,170,544,147,653,130,772,108,1002,99,1159"/>
<area shape="rect" href="classIpopt_1_1AmplOptionsList.html" title="Class for storing a number of AMPL options that should be registered to the AMPL Solver library inter..." alt="" coords="263,404,432,432"/>
<area shape="poly" title=" " alt="" coords="94,1159,103,1009,126,793,143,683,166,581,195,498,211,466,230,441,245,430,261,422,264,427,247,434,234,445,216,469,199,500,171,583,149,684,131,794,109,1009,100,1159"/>
<area shape="rect" href="classIpopt_1_1AmplOptionsList_1_1AmplOption.html" title="Ampl Option class containing name, type and description for an AMPL option." alt="" coords="263,456,432,500"/>
<area shape="poly" title=" " alt="" coords="95,1159,107,1023,132,828,150,729,172,638,198,563,213,533,230,511,244,498,261,489,264,494,247,503,234,514,218,536,203,565,177,639,155,730,137,829,112,1023,100,1160"/>
<area shape="rect" href="classIpopt_1_1AmplSuffixHandler.html" title=" " alt="" coords="255,524,440,552"/>
<area shape="poly" title=" " alt="" coords="95,1159,108,1031,134,852,152,761,174,678,199,609,214,583,230,563,253,547,256,551,233,566,218,586,204,611,179,679,157,762,139,853,114,1032,101,1160"/>
<area shape="rect" href="classIpopt_1_1IpoptAdditionalCq.html" title="Base class for additional calculated quantities that is special to a particular type of algorithm,..." alt="" coords="258,576,437,604"/>
<area shape="poly" title=" " alt="" coords="96,1159,110,1041,137,877,155,794,177,719,201,657,215,633,230,615,256,597,259,602,233,618,220,636,206,659,182,720,161,796,142,878,116,1042,101,1160"/>
<area shape="rect" href="classIpopt_1_1IpoptAdditionalData.html" title="Base class for additional data that is special to a particular type of algorithm, such as the CG pena..." alt="" coords="251,628,444,656"/>
<area shape="poly" title=" " alt="" coords="97,1159,113,1051,141,903,159,828,180,760,203,704,230,667,249,653,252,657,234,670,208,707,185,762,164,829,146,904,118,1051,102,1160"/>
<area shape="rect" href="classIpopt_1_1IpoptApplication.html" title="This is the main application class for making calls to Ipopt." alt="" coords="263,680,432,708"/>
<area shape="poly" title=" " alt="" coords="92,1159,95,1072,101,1016,112,954,129,890,154,827,187,769,230,719,245,708,261,700,264,705,247,712,233,722,191,772,159,830,134,892,118,955,107,1016,101,1073,98,1159"/>
<area shape="rect" href="classIpopt_1_1IpoptCalculatedQuantities.html" title="Class for all IPOPT specific calculated quantities." alt="" coords="232,732,463,760"/>
<area shape="poly" title=" " alt="" coords="93,1159,100,1081,119,976,136,920,160,866,191,815,230,771,248,758,251,762,233,774,195,818,165,868,141,922,124,978,105,1082,99,1159"/>
<area shape="rect" href="classIpopt_1_1IpoptData.html" title="Class to organize all the data required by the algorithm." alt="" coords="284,784,411,812"/>
<area shape="poly" title=" " alt="" coords="95,1159,104,1090,126,999,143,951,166,904,195,860,230,822,255,807,283,799,285,804,257,812,233,827,199,864,171,906,148,953,131,1000,109,1091,100,1159"/>
<area shape="rect" href="classIpopt_1_1IpoptNLP.html" title="This is the abstract base class for classes that map the traditional NLP into something that is more ..." alt="" coords="287,836,408,864"/>
<area shape="poly" title=" " alt="" coords="97,1159,109,1099,133,1022,151,981,172,942,199,906,230,874,257,859,286,851,287,856,259,864,233,879,203,909,177,945,155,984,138,1023,115,1100,102,1160"/>
<area shape="rect" href="classIpopt_1_1Journal.html" title="Journal class (part of the Journalist implementation.)." alt="" coords="294,888,401,916"/>
<area shape="poly" title=" " alt="" coords="100,1159,115,1109,141,1045,178,981,202,952,230,926,260,910,293,902,294,907,262,915,233,931,206,955,183,984,145,1048,120,1110,105,1161"/>
<area shape="rect" href="classIpopt_1_1Journalist.html" title="Class responsible for all message output." alt="" coords="286,940,409,968"/>
<area shape="poly" title=" " alt="" coords="104,1159,122,1118,149,1069,185,1020,230,978,257,965,285,957,286,962,258,970,233,983,189,1023,153,1072,127,1120,109,1161"/>
<area shape="rect" href="classIpopt_1_1LibraryLoader.html" title="loading of a library at runtime" alt="" coords="272,992,423,1020"/>
<area shape="poly" title=" " alt="" coords="110,1160,158,1094,192,1059,230,1030,270,1014,272,1019,233,1035,195,1063,162,1097,114,1163"/>
<area shape="rect" href="classIpopt_1_1MatrixSpace.html" title="MatrixSpace base class, corresponding to the Matrix base class." alt="" coords="276,1044,419,1072"/>
<area shape="poly" title=" " alt="" coords="119,1162,168,1121,198,1100,231,1082,275,1067,276,1072,233,1087,201,1104,171,1125,123,1166"/>
<area shape="rect" href="classIpopt_1_1Measurement.html" title=" " alt="" coords="271,1096,424,1124"/>
<area shape="poly" title=" " alt="" coords="142,1166,231,1134,277,1122,278,1127,232,1139,144,1171"/>
<area shape="rect" href="classIpopt_1_1NLP.html" title="Traditional NLP." alt="" coords="304,1148,391,1176"/>
<area shape="poly" title=" " alt="" coords="199,1175,303,1164,303,1169,199,1180"/>
<area shape="rect" href="classIpopt_1_1NLPScalingObject.html" title="This is the abstract base class for problem scaling." alt="" coords="259,1200,436,1228"/>
<area shape="poly" title=" " alt="" coords="199,1196,259,1202,258,1208,199,1202"/>
<area shape="rect" href="classIpopt_1_1OptionsList.html" title="This class stores a list of user set options." alt="" coords="280,1252,415,1280"/>
<area shape="poly" title=" " alt="" coords="146,1206,232,1237,280,1249,278,1254,231,1242,144,1211"/>
<area shape="rect" href="classIpopt_1_1PColumn.html" title="This class provides an easy interface for PCalculators with data where columns are not necessarily in..." alt="" coords="287,1304,408,1332"/>
<area shape="poly" title=" " alt="" coords="123,1211,172,1251,233,1289,288,1306,286,1311,231,1294,169,1256,120,1215"/>
<area shape="rect" href="classIpopt_1_1PointPerturber.html" title="This class is a simple object for generating randomly perturbed points that are within the NLP bounds..." alt="" coords="270,1356,425,1384"/>
<area shape="poly" title=" " alt="" coords="114,1214,162,1279,195,1313,233,1341,270,1356,268,1361,230,1345,192,1317,158,1282,110,1217"/>
<area shape="rect" href="classIpopt_1_1RegisteredCategory.html" title="A category of registered options." alt="" coords="252,1408,443,1436"/>
<area shape="poly" title=" " alt="" coords="109,1216,127,1256,154,1304,189,1353,233,1393,256,1405,253,1410,230,1397,185,1356,149,1307,122,1258,104,1218"/>
<area shape="rect" href="classIpopt_1_1RegisteredOption.html" title="Option that has been registered." alt="" coords="260,1460,435,1488"/>
<area shape="poly" title=" " alt="" coords="105,1217,120,1267,146,1329,183,1392,206,1421,233,1445,261,1460,258,1464,230,1449,203,1424,179,1395,141,1332,115,1269,100,1218"/>
<area shape="rect" href="classIpopt_1_1RegisteredOptions.html" title="Class for storing registered options." alt="" coords="256,1512,439,1540"/>
<area shape="poly" title=" " alt="" coords="102,1217,115,1277,138,1353,156,1393,177,1431,203,1466,233,1497,257,1511,255,1516,230,1501,199,1470,172,1434,151,1395,133,1355,109,1278,97,1218"/>
<area shape="rect" href="classIpopt_1_1SchurData.html" title="This interface serves as a reference point for multiple classes that need to use SchurData (PCalculat..." alt="" coords="283,1564,412,1592"/>
<area shape="poly" title=" " alt="" coords="100,1218,110,1286,131,1376,149,1424,171,1470,199,1512,233,1549,256,1563,283,1572,281,1577,254,1568,230,1553,195,1516,166,1472,144,1426,126,1378,104,1287,95,1219"/>
<area shape="rect" href="classIpopt_1_1SensApplication.html" title=" " alt="" coords="264,1616,431,1644"/>
<area shape="poly" title=" " alt="" coords="99,1218,105,1295,124,1399,141,1454,165,1508,195,1558,233,1601,248,1612,265,1619,263,1624,245,1616,230,1605,191,1561,160,1510,136,1456,119,1400,100,1296,94,1218"/>
<area shape="rect" href="classIpopt_1_1SensBuilder.html" title=" " alt="" coords="278,1668,417,1696"/>
<area shape="poly" title=" " alt="" coords="98,1218,101,1304,107,1360,118,1421,135,1485,159,1546,191,1603,233,1653,254,1667,278,1675,276,1680,252,1672,230,1657,187,1607,154,1549,129,1486,112,1423,102,1361,95,1304,92,1218"/>
<area shape="rect" href="classIpopt_1_1SolveStatistics.html" title="This class collects statistics about an optimization run, such as iteration count,..." alt="" coords="268,1720,427,1748"/>
<area shape="poly" title=" " alt="" coords="102,1217,118,1325,146,1472,164,1547,185,1614,208,1669,234,1705,250,1717,269,1725,267,1730,247,1722,230,1709,204,1671,180,1616,159,1548,141,1474,113,1326,97,1218"/>
<area shape="rect" href="classIpopt_1_1SuffixHandler.html" title="This class is the interface for all classes that can return indices." alt="" coords="272,1772,423,1800"/>
<area shape="poly" title=" " alt="" coords="101,1218,116,1336,143,1499,161,1581,182,1656,206,1717,220,1740,234,1757,251,1770,273,1778,271,1783,249,1775,230,1761,215,1743,201,1719,177,1657,156,1582,137,1500,111,1337,96,1219"/>
<area shape="rect" href="classIpopt_1_1TNLP.html" title="Base class for all NLP&#39;s that use standard triplet matrix form and dense vectors." alt="" coords="300,1824,395,1852"/>
<area shape="poly" title=" " alt="" coords="101,1217,114,1345,139,1523,157,1614,179,1697,204,1764,218,1790,234,1809,248,1820,264,1828,300,1836,299,1841,262,1833,245,1825,230,1813,214,1793,199,1767,174,1698,152,1615,134,1524,108,1345,95,1218"/>
<area shape="rect" href="classIpopt_1_1TaggedObject.html" title="TaggedObject class." alt="" coords="272,1876,423,1904"/>
<area shape="poly" title=" " alt="" coords="100,1218,112,1354,136,1548,154,1648,176,1738,202,1812,217,1840,234,1861,251,1875,273,1883,271,1888,249,1879,230,1865,213,1843,197,1814,170,1740,148,1649,130,1549,106,1355,95,1218"/>
<area shape="rect" href="classIpopt_1_1TimingStatistics.html" title="This class collects all timing statistics for Ipopt." alt="" coords="264,1928,431,1956"/>
<area shape="poly" title=" " alt="" coords="100,1217,110,1364,132,1573,150,1681,172,1779,200,1860,216,1890,234,1913,248,1924,264,1932,262,1937,245,1929,230,1917,212,1893,195,1862,167,1781,145,1682,127,1574,104,1364,94,1218"/>
<area shape="rect" href="classIpopt_1_1TripletToCSRConverter.html" title="Class for converting symmetric matrices given in triplet format to matrices in compressed sparse row ..." alt="" coords="244,1980,451,2008"/>
<area shape="poly" title=" " alt="" coords="99,1218,108,1373,129,1599,147,1715,169,1821,198,1907,215,1940,234,1965,249,1977,246,1982,230,1969,211,1943,193,1909,164,1822,141,1716,124,1599,102,1374,94,1218"/>
<area shape="rect" href="classIpopt_1_1VectorSpace.html" title="VectorSpace base class, corresponding to the Vector base class." alt="" coords="276,2032,419,2060"/>
<area shape="poly" title=" " alt="" coords="99,1217,106,1382,114,1498,126,1623,143,1747,166,1861,196,1955,214,1990,234,2017,253,2032,277,2040,275,2045,251,2036,230,2021,209,1993,191,1957,161,1863,138,1748,121,1623,108,1498,100,1382,94,1218"/>
<area shape="rect" href="classIpopt_1_1InexactAlgorithmBuilder.html" title="Builder to create a complete IpoptAlg object for the inexact step computation version." alt="" coords="520,5,740,33"/>
<area shape="poly" title=" " alt="" coords="378,120,437,81,510,43,548,31,549,36,512,48,440,86,381,125"/>
<area shape="rect" href="classIpopt_1_1AugSystemSolver.html" title="Base class for Solver for the augmented system." alt="" coords="541,57,718,85"/>
<area shape="poly" title=" " alt="" coords="368,321,509,96,539,81,542,85,513,100,373,324"/>
<area shape="rect" href="classIpopt_1_1BacktrackingLSAcceptor.html" title="Base class for backtracking line search acceptors." alt="" coords="520,109,740,137"/>
<area shape="poly" title=" " alt="" coords="365,320,388,279,421,232,462,186,510,148,535,135,537,140,512,152,465,190,425,236,393,282,369,323"/>
<area shape="rect" href="classIpopt_1_1ConvergenceCheck.html" title="Base class for checking the algorithm termination criteria." alt="" coords="536,161,723,189"/>
<area shape="poly" title=" " alt="" coords="373,322,431,259,468,226,510,199,540,187,542,192,512,204,472,231,435,262,377,325"/>
<area shape="rect" href="classIpopt_1_1EqMultiplierCalculator.html" title="Base Class for objects that compute estimates for the equality constraint multipliers y_c and y_d." alt="" coords="527,213,733,241"/>
<area shape="poly" title=" " alt="" coords="388,324,444,286,510,251,547,239,548,244,512,256,447,290,391,328"/>
<area shape="rect" href="classIpopt_1_1GenKKTSolverInterface.html" title="Base class for interfaces to symmetric indefinite linear solvers for generic matrices." alt="" coords="524,265,736,293"/>
<area shape="poly" title=" " alt="" coords="429,328,510,303,560,291,561,296,512,308,431,333"/>
<area shape="rect" href="classIpopt_1_1HessianUpdater.html" title="Abstract base class for objects responsible for updating the Hessian information." alt="" coords="547,317,713,345"/>
<area shape="poly" title=" " alt="" coords="453,345,546,336,546,342,454,350"/>
<area shape="rect" href="classIpopt_1_1InexactNewtonNormalStep.html" title="Compute the &quot;Newton&quot; normal step from the (slack&#45;scaled) augmented system." alt="" coords="511,369,748,397"/>
<area shape="poly" title=" " alt="" coords="453,365,511,370,510,375,453,370"/>
<area shape="rect" href="classIpopt_1_1InexactNormalStepCalculator.html" title="Base class for computing the normal step for the inexact step calculation algorithm." alt="" coords="536,421,723,466"/>
<area shape="poly" title=" " alt="" coords="440,383,464,390,512,406,550,418,549,423,510,411,462,395,439,388"/>
<area shape="rect" href="classIpopt_1_1InexactPDSolver.html" title="This is the implementation of the Primal&#45;Dual System, allowing the usage of an inexact linear solver." alt="" coords="545,489,714,517"/>
<area shape="poly" title=" " alt="" coords="453,382,465,391,482,412,489,435,496,456,513,476,546,492,543,497,509,480,491,459,484,436,478,415,461,394,450,387"/>
<area shape="rect" href="classIpopt_1_1IpoptAlgorithm.html" title="The main ipopt algorithm class." alt="" coords="550,541,709,569"/>
<area shape="poly" title=" " alt="" coords="453,381,465,391,479,408,486,426,489,461,492,495,499,511,513,527,530,538,551,546,549,551,528,543,509,530,495,514,487,496,484,461,481,427,474,411,461,394,450,385"/>
<area shape="rect" href="classIpopt_1_1IterateInitializer.html" title="Base class for all methods for initializing the iterates." alt="" coords="547,593,713,621"/>
<area shape="poly" title=" " alt="" coords="453,381,465,391,482,415,490,439,491,464,489,488,487,511,488,534,496,556,513,579,529,590,547,598,545,603,526,595,509,582,491,559,483,535,482,511,484,487,485,463,484,440,477,417,461,394,450,385"/>
<area shape="rect" href="classIpopt_1_1IterationOutput.html" title="Base class for objects that do the output summary per iteration." alt="" coords="549,645,710,673"/>
<area shape="poly" title=" " alt="" coords="453,380,465,391,485,422,493,453,493,484,489,514,484,544,484,573,493,602,513,631,530,643,550,652,548,656,527,648,509,634,488,604,479,574,479,543,483,513,488,483,488,453,480,424,461,394,450,384"/>
<area shape="rect" href="classIpopt_1_1IterativeSolverTerminationTester.html" title="This base class is for the termination tests for the iterative linear solver in the inexact version o..." alt="" coords="512,697,747,742"/>
<area shape="poly" title=" " alt="" coords="453,380,465,391,489,428,497,466,496,503,489,539,483,575,482,611,490,647,513,683,526,694,523,698,509,686,485,649,476,611,478,575,484,538,491,502,492,466,484,430,461,394,449,384"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a5c0f2208e3ead22bf7c5179381ed8203" id="r_a5c0f2208e3ead22bf7c5179381ed8203"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1ReferencedObject.html#a5c0f2208e3ead22bf7c5179381ed8203">ReferencedObject</a> ()</td></tr>
<tr class="separator:a5c0f2208e3ead22bf7c5179381ed8203"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adbbf3aa5307da62ab8224ba599d4bd7a" id="r_adbbf3aa5307da62ab8224ba599d4bd7a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classIpopt_1_1DependentResult.html">virtual</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1ReferencedObject.html#adbbf3aa5307da62ab8224ba599d4bd7a">~ReferencedObject</a> ()</td></tr>
<tr class="separator:adbbf3aa5307da62ab8224ba599d4bd7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aac517534e10e36c946aeefc6fe337777" id="r_aac517534e10e36c946aeefc6fe337777"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceIpopt.html#a5a4a27f325033a0e5d85a4ebc4038b57">Index</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1ReferencedObject.html#aac517534e10e36c946aeefc6fe337777">ReferenceCount</a> () <a class="el" href="classIpopt_1_1DependentResult.html">const</a></td></tr>
<tr class="separator:aac517534e10e36c946aeefc6fe337777"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa69ecb0f026bd741e2fa84c31d4ec332" id="r_aa69ecb0f026bd741e2fa84c31d4ec332"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classIpopt_1_1DependentResult.html">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1ReferencedObject.html#aa69ecb0f026bd741e2fa84c31d4ec332">AddRef</a> (<a class="el" href="classIpopt_1_1DependentResult.html">const</a> <a class="el" href="classIpopt_1_1Referencer.html">Referencer</a> *<a class="el" href="classIpopt_1_1DependentResult.html">referencer</a>) <a class="el" href="classIpopt_1_1DependentResult.html">const</a></td></tr>
<tr class="separator:aa69ecb0f026bd741e2fa84c31d4ec332"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6c952e7d1a63080dc8f121c008944fc" id="r_ae6c952e7d1a63080dc8f121c008944fc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classIpopt_1_1DependentResult.html">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1ReferencedObject.html#ae6c952e7d1a63080dc8f121c008944fc">ReleaseRef</a> (<a class="el" href="classIpopt_1_1DependentResult.html">const</a> <a class="el" href="classIpopt_1_1Referencer.html">Referencer</a> *<a class="el" href="classIpopt_1_1DependentResult.html">referencer</a>) <a class="el" href="classIpopt_1_1DependentResult.html">const</a></td></tr>
<tr class="separator:ae6c952e7d1a63080dc8f121c008944fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:aa99c6c922e04cf98edb2e7ea35cc046d" id="r_aa99c6c922e04cf98edb2e7ea35cc046d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceIpopt.html#a5a4a27f325033a0e5d85a4ebc4038b57">Index</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1ReferencedObject.html#aa99c6c922e04cf98edb2e7ea35cc046d">reference_count_</a></td></tr>
<tr class="separator:aa99c6c922e04cf98edb2e7ea35cc046d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Storing the reference count of all the smart pointers that currently reference it. </p>
<p>This is part of the implementation of an intrusive smart pointer design. See the documentation for the <a class="el" href="classIpopt_1_1SmartPtr.html" title="Template class for Smart Pointers.">SmartPtr</a> class for more details.</p>
<p>A <a class="el" href="classIpopt_1_1SmartPtr.html" title="Template class for Smart Pointers.">SmartPtr</a> behaves much like a raw pointer, but manages the lifetime of an object, deleting the object automatically. This class implements a reference-counting, intrusive smart pointer design, where all objects pointed to must inherit off of <a class="el" href="classIpopt_1_1ReferencedObject.html" title="Storing the reference count of all the smart pointers that currently reference it.">ReferencedObject</a>, which stores the reference count. Although this is intrusive (native types and externally authored classes require wrappers to be referenced by smart pointers), it is a safer design. A more detailed discussion of these issues follows after the usage information.</p>
<p>Usage Example: Note: to use the <a class="el" href="classIpopt_1_1SmartPtr.html" title="Template class for Smart Pointers.">SmartPtr</a>, all objects to which you point MUST inherit off of <a class="el" href="classIpopt_1_1ReferencedObject.html" title="Storing the reference count of all the smart pointers that currently reference it.">ReferencedObject</a>.</p>
<pre class="fragment">*
* In MyClass.hpp...
*
* #include "IpReferenced.hpp"

* namespace Ipopt {
*
*  class MyClass : public ReferencedObject // must derive from ReferencedObject
*    {
*      ...
*    }
* } // namespace Ipopt
*
*
* In my_usage.cpp...
*
* #include "IpSmartPtr.hpp"
* #include "MyClass.hpp"
*
* void func(AnyObject&amp; obj)
*  {
*    SmartPtr&lt;MyClass&gt; ptr_to_myclass = new MyClass(...);
*    // ptr_to_myclass now points to a new MyClass,
*    // and the reference count is 1
*
*    ...
*
*    obj.SetMyClass(ptr_to_myclass);
*    // Here, let's assume that AnyObject uses a
*    // SmartPtr&lt;MyClass&gt; internally here.
*    // Now, both ptr_to_myclass and the internal
*    // SmartPtr in obj point to the same MyClass object
*    // and its reference count is 2.
*
*    ...
*
*    // No need to delete ptr_to_myclass, this
*    // will be done automatically when the
*    // reference count drops to zero.
*
*  }
*
* </pre><p>Other Notes: The <a class="el" href="classIpopt_1_1SmartPtr.html" title="Template class for Smart Pointers.">SmartPtr</a> implements both dereference operators -&gt; &amp; *. The <a class="el" href="classIpopt_1_1SmartPtr.html" title="Template class for Smart Pointers.">SmartPtr</a> does NOT implement a conversion operator to the raw pointer. Use the <a class="el" href="namespaceIpopt.html#a4ae001947e506b5b8f4f134b8a4ead23">GetRawPtr()</a> method when this is necessary. Make sure that the raw pointer is NOT deleted. The <a class="el" href="classIpopt_1_1SmartPtr.html" title="Template class for Smart Pointers.">SmartPtr</a> implements the comparison operators == &amp; != for a variety of types. Use these instead of </p><pre class="fragment">*    if (GetRawPtr(smrt_ptr) == ptr) // Don't use this
*    </pre><p> <a class="el" href="classIpopt_1_1SmartPtr.html" title="Template class for Smart Pointers.">SmartPtr</a>'s, as currently implemented, do NOT handle circular references. For example: consider a higher level object using SmartPtrs to point to A and B, but A and B also point to each other (i.e. A has a <a class="el" href="classIpopt_1_1SmartPtr.html" title="Template class for Smart Pointers.">SmartPtr</a> to B and B has a <a class="el" href="classIpopt_1_1SmartPtr.html" title="Template class for Smart Pointers.">SmartPtr</a> to A). In this scenario, when the higher level object is finished with A and B, their reference counts will never drop to zero (since they reference each other) and they will not be deleted. This can be detected by memory leak tools like valgrind. If the circular reference is necessary, the problem can be overcome by a number of techniques:</p>
<p>1) A and B can have a method that "releases" each other, that is they set their internal SmartPtrs to NULL. </p><pre class="fragment">*        void AClass::ReleaseCircularReferences()
*          {
*          smart_ptr_to_B = NULL;
*          }
*        </pre><p> Then, the higher level class can call these methods before it is done using A &amp; B.</p>
<p>2) Raw pointers can be used in A and B to reference each other. Here, an implicit assumption is made that the lifetime is controlled by the higher level object and that A and B will both exist in a controlled manner. Although this seems dangerous, in many situations, this type of referencing is very controlled and this is reasonably safe.</p>
<p>3) This <a class="el" href="classIpopt_1_1SmartPtr.html" title="Template class for Smart Pointers.">SmartPtr</a> class could be redesigned with the Weak/Strong design concept. Here, the <a class="el" href="classIpopt_1_1SmartPtr.html" title="Template class for Smart Pointers.">SmartPtr</a> is identified as being Strong (controls lifetime of the object) or Weak (merely referencing the object). The Strong <a class="el" href="classIpopt_1_1SmartPtr.html" title="Template class for Smart Pointers.">SmartPtr</a> increments (and decrements) the reference count in <a class="el" href="classIpopt_1_1ReferencedObject.html" title="Storing the reference count of all the smart pointers that currently reference it.">ReferencedObject</a> but the Weak <a class="el" href="classIpopt_1_1SmartPtr.html" title="Template class for Smart Pointers.">SmartPtr</a> does not. In the example above, the higher level object would have Strong SmartPtrs to A and B, but A and B would have Weak SmartPtrs to each other. Then, when the higher level object was done with A and B, they would be deleted. The Weak SmartPtrs in A and B would not decrement the reference count and would, of course, not delete the object. This idea is very similar to item (2), where it is implied that the sequence of events is controlled such that A and B will not call anything using their pointers following the higher level delete (i.e. in their destructors!). This is somehow safer, however, because code can be written (however expensive) to perform run-time detection of this situation. For example, the <a class="el" href="classIpopt_1_1ReferencedObject.html" title="Storing the reference count of all the smart pointers that currently reference it.">ReferencedObject</a> could store pointers to all Weak SmartPtrs that are referencing it and, in its destructor, tell these pointers that it is dying. They could then set themselves to NULL, or set an internal flag to detect usage past this point.</p>
<p>For every most derived object only one <a class="el" href="classIpopt_1_1ReferencedObject.html" title="Storing the reference count of all the smart pointers that currently reference it.">ReferencedObject</a> may exist, that is multiple inheritance requires virtual inheritance, see also the 2nd point in ticket #162.</p>
<p>Comments on Non-Intrusive Design: In a non-intrusive design, the reference count is stored somewhere other than the object being referenced. This means, unless the reference counting pointer is the first referencer, it must get a pointer to the referenced object from another smart pointer (so it has access to the reference count location). In this non-intrusive design, if we are pointing to an object with a smart pointer (or a number of smart pointers), and we then give another smart pointer the address through a RAW pointer, we will have two independent, AND INCORRECT, reference counts. To avoid this pitfall, we use an intrusive reference counting technique where the reference count is stored in the object being referenced. </p>

<p class="definition">Definition at line <a class="el" href="IpReferenced_8hpp_source.html#l00169">169</a> of file <a class="el" href="IpReferenced_8hpp_source.html">IpReferenced.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a5c0f2208e3ead22bf7c5179381ed8203" name="a5c0f2208e3ead22bf7c5179381ed8203"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5c0f2208e3ead22bf7c5179381ed8203">&#9670;&#160;</a></span>ReferencedObject()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">Ipopt::ReferencedObject::ReferencedObject </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="IpReferenced_8hpp_source.html#l00172">172</a> of file <a class="el" href="IpReferenced_8hpp_source.html">IpReferenced.hpp</a>.</p>

</div>
</div>
<a id="adbbf3aa5307da62ab8224ba599d4bd7a" name="adbbf3aa5307da62ab8224ba599d4bd7a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adbbf3aa5307da62ab8224ba599d4bd7a">&#9670;&#160;</a></span>~ReferencedObject()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classIpopt_1_1DependentResult.html">virtual</a> Ipopt::ReferencedObject::~ReferencedObject </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="IpReferenced_8hpp_source.html#l00176">176</a> of file <a class="el" href="IpReferenced_8hpp_source.html">IpReferenced.hpp</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aac517534e10e36c946aeefc6fe337777" name="aac517534e10e36c946aeefc6fe337777"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aac517534e10e36c946aeefc6fe337777">&#9670;&#160;</a></span>ReferenceCount()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespaceIpopt.html#a5a4a27f325033a0e5d85a4ebc4038b57">Index</a> Ipopt::ReferencedObject::ReferenceCount </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="IpReferenced_8hpp_source.html#l00203">203</a> of file <a class="el" href="IpReferenced_8hpp_source.html">IpReferenced.hpp</a>.</p>

</div>
</div>
<a id="aa69ecb0f026bd741e2fa84c31d4ec332" name="aa69ecb0f026bd741e2fa84c31d4ec332"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa69ecb0f026bd741e2fa84c31d4ec332">&#9670;&#160;</a></span>AddRef()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classIpopt_1_1DependentResult.html">void</a> Ipopt::ReferencedObject::AddRef </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classIpopt_1_1DependentResult.html">const</a> <a class="el" href="classIpopt_1_1Referencer.html">Referencer</a> *&#160;</td>
          <td class="paramname"><em>referencer</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="IpReferenced_8hpp_source.html#l00211">211</a> of file <a class="el" href="IpReferenced_8hpp_source.html">IpReferenced.hpp</a>.</p>

</div>
</div>
<a id="ae6c952e7d1a63080dc8f121c008944fc" name="ae6c952e7d1a63080dc8f121c008944fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae6c952e7d1a63080dc8f121c008944fc">&#9670;&#160;</a></span>ReleaseRef()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classIpopt_1_1DependentResult.html">void</a> Ipopt::ReferencedObject::ReleaseRef </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classIpopt_1_1DependentResult.html">const</a> <a class="el" href="classIpopt_1_1Referencer.html">Referencer</a> *&#160;</td>
          <td class="paramname"><em>referencer</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="IpReferenced_8hpp_source.html#l00226">226</a> of file <a class="el" href="IpReferenced_8hpp_source.html">IpReferenced.hpp</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="aa99c6c922e04cf98edb2e7ea35cc046d" name="aa99c6c922e04cf98edb2e7ea35cc046d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa99c6c922e04cf98edb2e7ea35cc046d">&#9670;&#160;</a></span>reference_count_</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespaceIpopt.html#a5a4a27f325033a0e5d85a4ebc4038b57">Index</a> Ipopt::ReferencedObject::reference_count_</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">mutable</span><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="IpReferenced_8hpp_source.html#l00194">194</a> of file <a class="el" href="IpReferenced_8hpp_source.html">IpReferenced.hpp</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/Common/<a class="el" href="IpReferenced_8hpp_source.html">IpReferenced.hpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
</body>
</html>
